home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr38 / csd70.zip / CS.DOC < prev    next >
Text File  |  1995-04-18  |  16KB  |  353 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                                 CorpSoft BBS                                ║
  4. ║                       (815) 886-9381 - 3 Nodes 28.8 v.34                    ║
  5. ║                                                                             ║
  6. ║                            C A R D   S H A R K S                            ║
  7. ║                                 D E L U X E                                 ║
  8. ║                                    v7.0                                     ║
  9. ║                                                                             ║
  10. ║                              MULTI-BBS Support                              ║
  11. ║           Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,          ║
  12. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  13. ║                                                                             ║
  14. ║                               Copyright 1995                                ║
  15. ║                               by Robert Neal                                ║
  16. ║                             317 Hickory Avenue                              ║
  17. ║                            Romeoville, IL  60441                            ║
  18. ║                                                                             ║
  19. ╚═════════════════════════════════════════════════════════════════════════════╝
  20.  
  21. Changes to this documentation file from the previous version are
  22. indicated by "|" in the left hand margin. This should make finding
  23. changes to the documentation much easier and faster for those upgrading
  24. from previous versions.
  25.  
  26. Card Sharks is released as SHAREWARE. You are granted a limited license to
  27. evaluate the program. Try it out, if you continue to use it you are required
  28. to register the program.
  29.  
  30. To register the program send $14.95 along with your name and your BBS
  31. name and phone # to:
  32.         Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441.
  33.  
  34.  
  35. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  36. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  37. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  38. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  39. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  40. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  41.  
  42.  
  43. Card Sharks is based on the TV show of the same name with some minor 
  44. variations. Each time the player is started with $200 to wager. He may
  45. bet any amount he desires up to the amount in his bank. The rules of play
  46. are pretty self explanitory and are displayed in the new player information
  47. screen of the game itself therefore I will not cover them here.
  48.  
  49. In addition to the initial $200 bank, for each row the player advances
  50. he is given another $200. On the last row the player is given the chance to
  51. bet his winnings from the current game PLUS the winnings he started the 
  52. game with in his bankroll.  The player must then bet atleast half of his
  53. entire bank on the last row (and last card). Note that the player is only
  54. given $200 each time he starts the game, he is not given his entire bankroll
  55. to play the game, only for the final card.
  56.  
  57. On the final card, if the user hangs up without placing a wager on the top
  58. card, the program will automatically take half of his bankroll. I've seen
  59. where some users, in an attempt to play it safe, will hang up rather than
  60. play out the last card (especially if it's an 7, 8, etc.). This should keep
  61. the game more honest for everyone.
  62.  
  63.  
  64.  
  65. FEATURES OF CARD SHARKS
  66.  
  67.   -  Easy to install and requires no maintenance.
  68.  
  69.   -  Ansi color support.
  70.  
  71.   -  Terminates cleanly through exit code even on runtime error.
  72.  
  73.   -  Automatically creates a top score listing suitable for inclusion
  74.      as a text/bulletin file for display within your BBS. 
  75.  
  76.   -  Detects loss of carrier.
  77.  
  78.   -  Operates in local mode (either direct from BBS or from command line).
  79.  
  80.   -  Sysop function keys to return to the board, chat mode, user stats,
  81.      increase/decrease time, etc.
  82.  
  83.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, Ultra BBS,
  84.      Telegard, TriTel and Remote Access.
  85.  
  86.   -  Support for baud rates up to 115,200
  87.  
  88.   -  Support for COM0-15. Optional command line for non-standard IRQ's.
  89.  
  90.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  91.  
  92.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  93.      program.
  94.  
  95.   -  Fully Multi-Node compatible.
  96.  
  97.   -  Supports fossil based multi-port boards such as for PCBoard /M
  98.      version.
  99.  
  100.   -  Option to make up days missed
  101.  
  102.   -  Option to show who "adopted" the door
  103.  
  104.  
  105. FIRST TIME OPERATIONS
  106.  
  107. If you are setting up a game for the first time you MUST pass the command
  108. parameter "NEW" to the program so that it will create the necessary files,
  109. ie. CS NEW. This is the only time that you need to pass this parameter,
  110. but you may use it to restart a game before the monthly maintenance. Note
  111. that passing the 'NEW' parameter will NOT cause the current high score file
  112. TOPCS to be converted to the TOPOLD file.
  113.  
  114. The 'NEW' will wipe out all current files, so be sure you want to 'NEW'
  115. the game before using it.
  116.  
  117.  
  118. UPGRADING FROM VERSIONS PRIOR TO v6.0
  119.  
  120. The user file in Card Sharks has been changed in v6.0 to accomodate the
  121. make up game option. You will need to convert the user file to the new
  122. format. While in the Card Sharks directory, type CSCONFIG CONVERT. The
  123. user file will be automatically converted to the new format. The
  124. conversion routine has been made "smart", ie it checks if the user
  125. file has been converted already, but you should not try to run the
  126. conversion after the file has been converted. A back-up, named
  127. CARDSHRK.XXX will be created of your original CARDSHRK.USR file after
  128. the conversion is done. Once you have verified that the conversion was
  129. successful, you can delete the CARDSHRK.XXX file.
  130.  
  131.  
  132. AUTOMATIC MAINTENANCE
  133.  
  134. The program will automatically during the first play of each new month
  135. reset it's user file and top score listing. The previous months top score
  136. listing (TOPCS) will automatically be renamed to TOPOLD. This  can then
  137. be included as a text file to display the previous months winners.
  138.  
  139. You should be aware of this so if you are starting a new game for the
  140. first time towards the end of the month, the game will automatically perform
  141. the maintenace come the first of the month.
  142.  
  143.  
  144. CONFIGURING THE PROGRAM
  145.  
  146. Included is a program called CSCONFIG.EXE. You may use this program to
  147. create and/or edit the configuration files. To use CSCONFIG, type
  148. CSCONFIG CS.CFG. This editor will allow you to enter the appropriate
  149. configuration editor within it's own full screen editor as well as edit
  150. the CS.TXT file. Below is the layout of the CS.CFG file if you wish to
  151. edit it manually.
  152.  
  153. C:\PCB\PCBOARD.SYS
  154. Corporate Headquarters
  155. Bob
  156. Neal
  157. 3
  158. 100
  159. NOBANKRUPT
  160. 0
  161. 6
  162. NA
  163.  
  164. Line 1 = Full pathname of your door file. Formats supported by this
  165.          program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  166.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  167.                       GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
  168.                       USERINFO.DAT, DOOR.SYS  must be in the same
  169.                       directory as USERINFO.DAT.
  170. Line 2 = BBS name
  171. Line 3 = Sysop First Name
  172. Line 4 = Sysop Last Name
  173. Line 5 = number of times per day that a player may play the game
  174.          if you do not wish to limit the number of daily plays enter
  175.          a large number (999 for example). I would suggest the a daily
  176.          limit be used (3 is a good number to use) so as to prevent
  177.          some users from running up the scores (Registered version only.
  178.          Non-registered version will default to 3).
  179. Line 6 = Probability of a Joker being added to the deck. This is a new
  180.          option in v5.1. Enter 100 if you want 1 joker added (100%
  181.          probablility), enter 200 for 2 jokers or you may enter 50 to
  182.          have a 50% probability that a joker would be hit. Do not set
  183.          this value to high otherwise the users may get tired of
  184.          seeing the joker pop up. I recommend a value between 50-100.
  185. Line 7 = You can set the option to either bankrupt the player (the
  186.          entire bankroll is lost) or just the turns remaining for that
  187.          day if the joker is hit. Enter either BANKRUPT or NOBANKRUPT -
  188.          I recommend NOBANKRUPT.
  189. Line 8 = Registration number. Leave as 0 if unregistered.
  190. Line 9 = Maximum number of plays allowed to make up. Users can make up
  191.          lost days of play. Put in the number of plays you allow the
  192.          user to make up each day. This number reflects the number of
  193.          PLAYS you will allow, not the number of DAYS. Enter a 0
  194.          if you wish to disable this option (registered version only).
  195. Line10 = Several sysops have had users pay the registration for door
  196.          programs they enjoy playing. You can now give credit to anyone
  197.          who "adopts" this door, put their name(s) on this line. To
  198.          disable, enter NA (registered version only).
  199.  
  200. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  201. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  202. including the following either in your BBS batch or AUTOEXEC.BAT file:
  203.  
  204.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  205.     SET PCBDIR=\BBS            <- Path of your BBS files
  206.  
  207. Then, in your CS.CFG file, on the first line you may put:
  208.  
  209.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  210.  
  211. This allows you to use just one .CFG file for multi-node operation.
  212.  
  213.  
  214.  
  215. EXECUTING PROGRAM
  216.  
  217. To execute the program, enter the filename followed by the config file
  218. name (ie CS.EXE CS.CFG). If you are running the program from the command
  219. line, you may optionally enter CS.EXE LOCAL. The only problem with this
  220. is the default user name sysop is used instead of the name on your board.
  221. This is good for testing the game before putting it on your system, but
  222. you should once play begins, execute the program locally from your BBS or
  223. consistantly run the game from the command line when you play.
  224.  
  225. You may also specify a non-standard IRQ. Put the IRQ number after the
  226. .CFG on the command line. For example: CS CS.CFG /5. This example tells
  227. the program to use IRQ 5 instead of the standard IRQ.
  228.  
  229. You may also use the procedure above and create a variable IRQ so that
  230. you can pass the IRQ setting as: CS CS.CFG /%IRQ%
  231.  
  232. Some users may have had conflicts when using non-standard IRQ's on
  233. Novell/Netware systems. Novell seems to use the "/" character for
  234. parameter passing. You may not optionally use the "*" character instead
  235. of the "/", for example CS CS.CFG *%IRQ% is valid. Both "*" and "/"
  236. will work.
  237.  
  238.  
  239. FOSSIL DRIVER
  240. =============
  241.  
  242. Card Sharks now includes support for FOSSIL drivers. This means that the
  243. program will now work with Digiboard (for Wildcat IM and PCBoard/M
  244. versions) and other multi-port boards. To activate the Fossil driver
  245. support just include /FD on the command line in your door batch file.
  246.  
  247.         For example: CS CS.CFG /FD
  248.  
  249. If no Fossil driver is available, Card Sharks will display a message
  250. indicating such and exit cleanly.
  251.  
  252.  
  253.  
  254. This documentation will not go into the mechanics of how you set-up a door
  255. program on your BBS. It is assumed that you have a working knowledge of
  256. how to complete this task.
  257.  
  258.  
  259. SYSOP KEYS ACTIVE
  260.  
  261. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  262.          written to DOOR.SYS and USERS.SYS
  263. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  264.          and/or written to DOOR.SYS and USERS.SYS
  265. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  266. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  267.          and/or written to DOOR.SYS and USERS.SYS
  268. F8    -  Returns the caller involuntarily to the BBS.
  269. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  270.          and/or written to DOOR.SYS and USERS.SYS
  271. F10   -  Activates SysOp CHAT mode within the DOOR.
  272. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  273. UP    -  Give the caller extra time while in the DOOR.  
  274. DN    -  Subtract time from the caller while in the DOOR. 
  275. HOME  -  HELP key for Status Line options.
  276. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  277. ALT-X -  PCBoard will exit after current caller logs off. Value is
  278.          passed to PCBoard. Not available on non-PCBoard systems.
  279.  
  280.  
  281.  
  282.  
  283. FILES USED AND CREATED
  284.  
  285. CS.EXE   - The program itself (may want to rename to CS.EXE)
  286. CS.DOC   - Documentation for the sysop to run Card Sharks
  287. CS.CFG   - Configuration file
  288. CS.TXT   - Option text file with comments for winning and losing. This
  289.            file will only be read by REGISTERED versions of Card Sharks.
  290. CSHLP   - New player welcome screen in ASCII text format
  291. CSGHLP  - New player welcome screen in ANSI format.
  292. CSOPENG - Opening screen shown to ANSI callers.
  293. CSOPEN  - Opening screen shown to NON-ANSI callers.
  294.  
  295. The following files will be created by Card Sharks
  296.  
  297. CARDSHRK.USR - User file of current players
  298. TOPCS        - Top scores in ascii format can be used as a bulletin
  299. TOPCSG       - Top scores in ansi format can be used as a bulletin
  300. TOP.CS       - Top scores data file
  301. TOPOLD       - Previous months ascii score listing, created at the
  302.                 beginning of each new month
  303. TOPOLDG      - Previous months ansi score listing, created at the
  304.                 beginning of each new month
  305. HISCORE.CS   - Data file with name and amount of highest earnings ever.
  306.  
  307.  
  308. THE GAME ITSELF
  309.  
  310. The game starts by displaying the Card Sharks opening screen (please do not
  311. modify this or any other part of the game), and will ask the user if he 
  312. wants to use ANSI colors. While the BBS door info file passes the variable for
  313. if a user has ANSI on or off, this gives those players a chance who may have
  314. ANSI off for normal BBS useage to use ANSI colors while in the door.
  315.  
  316. From here, if the player is a new player he is informed of the rules of play
  317. and his account in established. If he is a current player he will be shown
  318. his player stats right away (last time on, bankroll, etc) and then play
  319. will begin. The users stats are updated after each guess (right or wrong)
  320. so as to prevent callers from disconnecting if the hit bankrupt on a bad
  321. guess.
  322.  
  323. Play continues until the players bank account hits zero or the last card 
  324. is played.  The top score listing is then updated with the new standings.
  325.  
  326.  
  327.  
  328. CONTACT ME FOR SUPPORT
  329.  
  330. If you encounter any problems you may contact me at CorpSoft BBS (815)
  331. 886-9381.
  332.  
  333. If you have any suggestions for improvements for this program, please feel
  334. free to let me know.
  335.  
  336.  
  337. DISTRIBUTION SITE:
  338.  
  339.    As always you can find the latest version of Card Sharks available for
  340.    downloading from CorpSoft BBS.
  341.  
  342.    Calls for support for Card Sharks should be directed only to
  343.    CorpSoft BBS.
  344.  
  345.    CorpSoft BBS   (815) 886-3233
  346.                         886-9381
  347.                         886-9388
  348.         All nodes operating with USR Courier v.Everything @ 28.8
  349.  
  350. You can register with your Visa/MasterCard. Save time and register
  351. online by calling CorpSoft BBS, simply type CHARGE at the main menu
  352. prompt.
  353.